home *** CD-ROM | disk | FTP | other *** search
- /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is XPCOM Array interface.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications Corp.
- * Portions created by the Initial Developer are Copyright (C) 2002
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- * Alec Flett <alecf@netscape.com>
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either the GNU General Public License Version 2 or later (the "GPL"), or
- * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
- #include "nsISupports.idl"
-
- interface nsISimpleEnumerator;
-
- /**
- * nsIArray
- *
- * An indexed collection of elements. Provides basic functionality for
- * retrieving elements at a specific position, searching for
- * elements. Indexes are zero-based, such that the last element in the
- * array is stored at the index length-1.
- *
- * For an array which can be modified, see nsIMutableArray below.
- *
- * Neither interface makes any attempt to protect the individual
- * elements from modification. The convention is that the elements of
- * the array should not be modified. Documentation within a specific
- * interface should describe variations from this convention.
- *
- * It is also convention that if an interface provides access to an
- * nsIArray, that the array should not be QueryInterfaced to an
- * nsIMutableArray for modification. If the interface in question had
- * intended the array to be modified, it would have returned an
- * nsIMutableArray!
- *
- * null is a valid entry in the array, and as such any nsISupports
- * parameters may be null, except where noted.
- *
- * @status UNDER_REVIEW
- */
- [scriptable, uuid(114744d9-c369-456e-b55a-52fe52880d2d)]
- interface nsIArray : nsISupports
- {
- /**
- * length
- *
- * number of elements in the array.
- */
- readonly attribute unsigned long length;
-
- /**
- * queryElementAt()
- *
- * Retrieve a specific element of the array, and QueryInterface it
- * to the specified interface. null is a valid result for
- * this method, but exceptions are thrown in other circumstances
- *
- * @param index position of element
- * @param uuid the IID of the requested interface
- * @param result the object, QI'd to the requested interface
- *
- * @throws NS_ERROR_NO_INTERFACE when an entry exists at the
- * specified index, but the requested interface is not
- * available.
- * @throws NS_ERROR_ILLEGAL_VALUE when index > length-1
- *
- */
- void queryElementAt(in unsigned long index,
- in nsIIDRef uuid,
- [iid_is(uuid), retval] out nsQIResult result);
-
- /**
- * indexOf()
- *
- * Get the position of a specific element. Note that since null is
- * a valid input, exceptions are used to indicate that an element
- * is not found.
- *
- * @param startIndex The initial element to search in the array
- * To start at the beginning, use 0 as the
- * startIndex
- * @param element The element you are looking for
- * @returns a number >= startIndex which is the position of the
- * element in the array.
- * @throws NS_ERROR_NOT_FOUND if the element was not in the array.
- */
- unsigned long indexOf(in unsigned long startIndex,
- in nsISupports element);
-
- /**
- * enumerate the array
- *
- * @returns a new enumerator positioned at the start of the array
- * @throws NS_ERROR_FAILURE if the array is empty (to make it easy
- * to detect errors)
- */
- nsISimpleEnumerator enumerate();
-
- };
-
- /**
- * nsIMutableArray
- * A separate set of methods that will act on the array. Consumers of
- * nsIArray should not QueryInterface to nsIMutableArray unless they
- * own the array.
- *
- * As above, it is legal to add null elements to the array. Note also
- * that null elements can be created as a side effect of
- * insertElementAt(). Conversely, if insertElementAt() is never used,
- * and null elements are never explicitly added to the array, then it
- * is guaranteed that queryElementAt() will never return a null value.
- *
- * Any of these methods may throw NS_ERROR_OUT_OF_MEMORY when the
- * array must grow to complete the call, but the allocation fails.
- *
- * @status UNDER_REVIEW
- */
-
- [scriptable, uuid(af059da0-c85b-40ec-af07-ae4bfdc192cc)]
- interface nsIMutableArray : nsIArray
- {
- /**
- * appendElement()
- *
- * Append an element at the end of the array.
- *
- * @param element The element to append.
- * @param weak Whether or not to store the element using a weak
- * reference.
- * @throws NS_ERROR_FAILURE when a weak reference is requested,
- * but the element does not support
- * nsIWeakReference.
- */
- void appendElement(in nsISupports element, in boolean weak);
-
- /**
- * removeElementAt()
- *
- * Remove an element at a specific position, moving all elements
- * stored at a higher position down one.
- * To remove a specific element, use indexOf() to find the index
- * first, then call removeElementAt().
- *
- * @param index the position of the item
- *
- */
- void removeElementAt(in unsigned long index);
-
- /**
- * insertElementAt()
- *
- * Insert an element at the given position, moving the element
- * currently located in that position, and all elements in higher
- * position, up by one.
- *
- * @param element The element to insert
- * @param index The position in the array:
- * If the position is lower than the current length
- * of the array, the elements at that position and
- * onwards are bumped one position up.
- * If the position is equal to the current length
- * of the array, the new element is appended.
- * An index lower than 0 or higher than the current
- * length of the array is invalid and will be ignored.
- *
- * @throws NS_ERROR_FAILURE when a weak reference is requested,
- * but the element does not support
- * nsIWeakReference.
- */
- void insertElementAt(in nsISupports element, in unsigned long index, in boolean weak);
-
- /**
- * replaceElementAt()
- *
- * Replace the element at the given position.
- *
- * @param element The new element to insert
- * @param index The position in the array
- * If the position is lower than the current length
- * of the array, an existing element will be replaced.
- * If the position is equal to the current length
- * of the array, the new element is appended.
- * If the position is higher than the current length
- * of the array, empty elements are appended followed
- * by the new element at the specified position.
- * An index lower than 0 is invalid and will be ignored.
- *
- * @param weak Whether or not to store the new element using a weak
- * reference.
- *
- * @throws NS_ERROR_FAILURE when a weak reference is requested,
- * but the element does not support
- * nsIWeakReference.
- */
- void replaceElementAt(in nsISupports element, in unsigned long index, in boolean weak);
-
-
- /**
- * clear()
- *
- * clear the entire array, releasing all stored objects
- */
- void clear();
- };
-